home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / u_man / cat1 / pod2man.z / pod2man
Text File  |  1998-10-30  |  11KB  |  331 lines
  1.  
  2.  
  3.  
  4. PPPPOOOODDDD2222MMMMAAAANNNN((((1111))))                                                          PPPPOOOODDDD2222MMMMAAAANNNN((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      pod2man - translate embedded Perl pod directives into man pages
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ppppoooodddd2222mmmmaaaannnn [ --------sssseeeeccccttttiiiioooonnnn====_m_a_n_e_x_t ] [ --------rrrreeeelllleeeeaaaasssseeee====_r_e_l_p_a_t_c_h ] [ --------cccceeeennnntttteeeerrrr====_s_t_r_i_n_g ] [
  13.      --------ddddaaaatttteeee====_s_t_r_i_n_g ] [ --------ffffiiiixxxxeeeedddd====_f_o_n_t ] [ --------ooooffffffffiiiicccciiiiaaaallll ] [ --------llllaaaaxxxx ] _i_n_p_u_t_f_i_l_e
  14.  
  15. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.      ppppoooodddd2222mmmmaaaannnn converts its input file containing embedded pod directives (see
  17.      the _p_e_r_l_p_o_d manpage) into nroff source suitable for viewing with _n_r_o_f_f(1)
  18.      or _t_r_o_f_f(1) using the _m_a_n(7) macro set.
  19.  
  20.      Besides the obvious pod conversions, ppppoooodddd2222mmmmaaaannnn also takes care of _f_u_n_c(),
  21.      _f_u_n_c(n), and simple variable references like $foo or @bar so you don't
  22.      have to use code escapes for them; complex expressions like
  23.      $fred{'stuff'} will still need to be escaped, though.  Other nagging
  24.      little roffish things that it catches include translating the minus in
  25.      something like foo-bar, making a long dash--like this--into a real em
  26.      dash, fixing up "paired quotes", putting a little space after the parens
  27.      in something like _f_u_n_c(), making C++ and pi look right, making double
  28.      underbars have a little tiny space between them, making ALLCAPS a teeny
  29.      bit smaller in _t_r_o_f_f(1), and escaping backslashes so you don't have to.
  30.  
  31. OOOOPPPPTTTTIIIIOOOONNNNSSSS
  32.      center  Set the centered header to a specific string.  The default is
  33.              "User Contributed Perl Documentation", unless the --official flag
  34.              is given, in which case the default is "Perl Programmers
  35.              Reference Guide".
  36.  
  37.      date    Set the left-hand footer string to this value.  By default, the
  38.              modification date of the input file will be used.
  39.  
  40.      fixed   The fixed font to use for code refs.  Defaults to CW.
  41.  
  42.      official
  43.              Set the default header to indicate that this page is of the
  44.              standard release in case --center is not given.
  45.  
  46.      release Set the centered footer.  By default, this is the current perl
  47.              release.
  48.  
  49.      section Set the section for the .TH macro.  The standard conventions on
  50.              sections are to use 1 for user commands,  2 for system calls, 3
  51.              for functions, 4 for devices, 5 for file formats, 6 for games, 7
  52.              for miscellaneous information, and 8 for administrator commands.
  53.              This works best if you put your Perl man pages in a separate
  54.              tree, like /_u_s_r/_l_o_c_a_l/_p_e_r_l/_m_a_n/.  By default, section 1 will be
  55.              used unless the file ends in ._p_m in which case section 3 will be
  56.              selected.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. PPPPOOOODDDD2222MMMMAAAANNNN((((1111))))                                                          PPPPOOOODDDD2222MMMMAAAANNNN((((1111))))
  71.  
  72.  
  73.  
  74.      lax     Don't complain when required sections aren't present.
  75.  
  76. AAAAnnnnaaaattttoooommmmyyyy ooooffff aaaa PPPPrrrrooooppppeeeerrrr MMMMaaaannnn PPPPaaaaggggeeee
  77.      For those not sure of the proper layout of a man page, here's an example
  78.      of the skeleton of a proper man page.  Head of the major headers should
  79.      be setout as a =head1 directive, and are historically written in the
  80.      rather startling ALL UPPER CASE format, although this is not mandatory.
  81.      Minor headers may be included using =head2, and are typically in mixed
  82.      case.
  83.  
  84.      NAME      Mandatory section; should be a comma-separated list of programs
  85.                or functions documented by this podpage, such as:
  86.  
  87.                    foo, bar - programs to do something
  88.  
  89.  
  90.      SYNOPSIS  A short usage summary for programs and functions, which may
  91.                someday be deemed mandatory.
  92.  
  93.      DESCRIPTION
  94.                Long drawn out discussion of the program.  It's a good idea to
  95.                break this up into subsections using the =head2 directives,
  96.                like
  97.  
  98.                    =head2 A Sample Subection
  99.  
  100.                    =head2 Yet Another Sample Subection
  101.  
  102.  
  103.      OPTIONS   Some people make this separate from the description.
  104.  
  105.      RETURN VALUE
  106.                What the program or function returns if successful.
  107.  
  108.      ERRORS    Exceptions, return codes, exit stati, and errno settings.
  109.  
  110.      EXAMPLES  Give some example uses of the program.
  111.  
  112.      ENVIRONMENT
  113.                Envariables this program might care about.
  114.  
  115.      FILES     All files used by the program.  You should probably use the F<>
  116.                for these.
  117.  
  118.      SEE ALSO  Other man pages to check out, like _m_a_n(1), _m_a_n(7),
  119.                _m_a_k_e_w_h_a_t_i_s(8), or _c_a_t_m_a_n(8).
  120.  
  121.      NOTES     Miscellaneous commentary.
  122.  
  123.      CAVEATS   Things to take special care with; sometimes called WARNINGS.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. PPPPOOOODDDD2222MMMMAAAANNNN((((1111))))                                                          PPPPOOOODDDD2222MMMMAAAANNNN((((1111))))
  137.  
  138.  
  139.  
  140.      DIAGNOSTICS
  141.                All possible messages the program can print out--and what they
  142.                mean.
  143.  
  144.      BUGS      Things that are broken or just don't work quite right.
  145.  
  146.      RESTRICTIONS
  147.                Bugs you don't plan to fix :-)
  148.  
  149.      AUTHOR    Who wrote it (or AUTHORS if multiple).
  150.  
  151.      HISTORY   Programs derived from other sources sometimes have this, or you
  152.                might keep a modification log here.
  153.  
  154. EEEEXXXXAAAAMMMMPPPPLLLLEEEESSSS
  155.          pod2man program > program.1
  156.          pod2man some_module.pm > /usr/perl/man/man3/some_module.3
  157.          pod2man --section=7 note.pod > note.7
  158.  
  159.  
  160. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  161.      The following diagnostics are generated by ppppoooodddd2222mmmmaaaannnn.  Items marked "(W)"
  162.      are non-fatal, whereas the "(F)" errors will cause ppppoooodddd2222mmmmaaaannnn to immediately
  163.      exit with a non-zero status.
  164.  
  165.      bad option in paragraph %d of %s: ``%s'' should be [%s]<%s>
  166.          (W) If you start include an option, you should set it off as bold,
  167.          italic, or code.
  168.  
  169.      can't open %s: %s
  170.          (F) The input file wasn't available for the given reason.
  171.  
  172.      Improper man page - no dash in NAME header in paragraph %d of %s
  173.          (W) The NAME header did not have an isolated dash in it.  This is
  174.          considered important.
  175.  
  176.      Invalid man page - no NAME line in %s
  177.          (F) You did not include a NAME header, which is essential.
  178.  
  179.      roff font should be 1 or 2 chars, not `%s'  (F)
  180.          (F) The font specified with the --fixed option was not a one- or
  181.          two-digit roff font.
  182.  
  183.      %s is missing required section: %s
  184.          (W) Required sections include NAME, DESCRIPTION, and if you're using
  185.          a section starting with a 3, also a SYNOPSIS.  Actually, not having a
  186.          NAME is a fatal.
  187.  
  188.      Unknown escape: %s in %s
  189.          (W) An unknown HTML entity (probably for an 8-bit character) was
  190.          given via a E<> directive.  Besides amp, lt, gt, and quot, recognized
  191.          entities are Aacute, aacute, Acirc, acirc, AElig, aelig, Agrave,
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. PPPPOOOODDDD2222MMMMAAAANNNN((((1111))))                                                          PPPPOOOODDDD2222MMMMAAAANNNN((((1111))))
  203.  
  204.  
  205.  
  206.          agrave, Aring, aring, Atilde, atilde, Auml, auml, Ccedil, ccedil,
  207.          Eacute, eacute, Ecirc, ecirc, Egrave, egrave, ETH, eth, Euml, euml,
  208.          Iacute, iacute, Icirc, icirc, Igrave, igrave, Iuml, iuml, Ntilde,
  209.          ntilde, Oacute, oacute, Ocirc, ocirc, Ograve, ograve, Oslash, oslash,
  210.          Otilde, otilde, Ouml, ouml, szlig, THORN, thorn, Uacute, uacute,
  211.          Ucirc, ucirc, Ugrave, ugrave, Uuml, uuml, Yacute, yacute, and yuml.
  212.  
  213.      Unmatched =back
  214.          (W) You have a =back without a corresponding =over.
  215.  
  216.      Unrecognized pod directive: %s
  217.          (W) You specified a pod directive that isn't in the known list of
  218.          =head1, =head2, =item, =over, =back, or =cut.
  219.  
  220. NNNNOOOOTTTTEEEESSSS
  221.      If you would like to print out a lot of man page continuously, you
  222.      probably want to set the C and D registers to set contiguous page
  223.      numbering and even/odd paging, at least on some versions of _m_a_n(7).
  224.      Settting the F register will get you some additional experimental
  225.      indexing:
  226.  
  227.          troff -man -rC1 -rD1 -rF1 perl.1 perldata.1 perlsyn.1 ...
  228.  
  229.      The indexing merely outputs messages via .tm for each major page,
  230.      section, subsection, item, and any X<> directives.
  231.  
  232. RRRREEEESSSSTTTTRRRRIIIICCCCTTTTIIIIOOOONNNNSSSS
  233.      None at this time.
  234.  
  235. BBBBUUUUGGGGSSSS
  236.      The =over and =back directives don't really work right.  They take
  237.      absolute positions instead of offsets, don't nest well, and making people
  238.      count is suboptimal in any event.
  239.  
  240. AAAAUUUUTTTTHHHHOOOORRRRSSSS
  241.      Original prototype by Larry Wall, but so massively hacked over by Tom
  242.      Christiansen such that Larry probably doesn't recognize it anymore.
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. PPPPOOOODDDD2222MMMMAAAANNNN((((1111))))                                                          PPPPOOOODDDD2222MMMMAAAANNNN((((1111))))
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.                                                                         PPPPaaaaggggeeee 5555
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.